Update /docs/hosted-instances page#2173
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis PR updates the ENSNode hosted instance documentation by refactoring components to support structured metadata display via named slots, exporting reusable compatibility constants, and updating sidebar labels. The changes move instance descriptions from inline ChangesHosted Instance Documentation Refactoring
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related issues
Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro`:
- Line 6: The version constant ensNodeVersion is malformed ("v.1.13.1" has an
extra dot); update the value of ensNodeVersion to a correctly formatted semantic
label such as "v1.13.1" (or "1.13.1" if the leading "v" is not desired) so the
docs UI renders the version without the stray period.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 9466a0ae-3eb8-4f06-a338-17edf6441326
📒 Files selected for processing (4)
docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.tsdocs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astrodocs/ensnode.io/src/components/molecules/HostedInstanceSdkVersionWarning.astrodocs/ensnode.io/src/content/docs/docs/hosted-instances.mdx
Greptile SummaryThis PR updates the
Confidence Score: 5/5Safe to merge — this is a documentation-only change with no logic that could affect application behaviour. All changes are limited to MDX content, Astro template markup, and a sidebar label rename. The previously reported issues (misspelled variable name, leading whitespace, unused imports, spurious version dot, dead purpose prop) are resolved in the current revision. No new defects were found. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
MDX["hosted-instances.mdx\n(exported string constants)"]
HEI["HostedEnsNodeInstances.astro\n(table component)"]
WARN["HostedInstanceSdkVersionWarning.astro\n(caution banner)"]
MDX -->|instanceURL, namespace, deployments, plugins| HEI
MDX -->|slot: ens-omnigraph-api| HEI
MDX -->|slot: ens-subgraph-api| HEI
MDX -->|slot: ens-protocol-acceleration| HEI
MDX -->|for=both| WARN
HEI --> ROW1["Hosted at (URL + ENSAdmin link)"]
HEI --> ROW2["ENSNode Version (v1.13.1)"]
HEI --> ROW3["ENS Namespace"]
HEI --> ROW4["ENS Deployments"]
HEI --> ROW5["Active Plugins"]
HEI --> ROW6["APIs (dl with dt/dd per slot)"]
WARN --> LINK["Link → /docs/hosted-instances"]
Reviews (2): Last reviewed commit: "Improve definition list styling" | Re-trigger Greptile |
There was a problem hiding this comment.
Pull request overview
Updates the docs site’s “Hosted ENSNode Instances” content to more clearly communicate what each hosted endpoint supports (namespace, ENS deployments, and API compatibility), and tweaks related navigation/wording for better clarity.
Changes:
- Expanded
/docs/hosted-instancesto describe per-instance API support (Omnigraph/Subgraph/Protocol Acceleration) and ENS deployment coverage. - Updated the hosted-instance UI component to display ENSNode version, deployments, and API descriptions via slots.
- Refined docs UI copy and sidebar labels for clearer integration navigation.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx | Reworks the hosted instances page to highlight APIs/compatibility and adds new per-instance descriptions. |
| docs/ensnode.io/src/components/molecules/HostedInstanceSdkVersionWarning.astro | Adjusts the warning copy to link to the hosted instances page. |
| docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro | Updates the instance summary table to include version/deployments and API slots. |
| docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.ts | Renames sidebar labels to be more explicit/concise. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| const { instanceURL, connectWithENSAdminURL, namespace, deployments, plugins } = Astro.props; | ||
| export const ensNodeVersion = "v1.13.1"; |
| <Aside type="caution" title="Version compatibility with hosted instances"> | ||
| Our hosted ENSNode instances currently run ENSNode v1.13. If you are querying them from your own app, you <strong>must</strong> use <span set:html={sdkList} />. The latest published versions (<code>1.14.0+</code>) contain breaking changes in the Omnigraph API data model not yet deployed to our hosted infrastructure. Use these exact install commands: | ||
| <a href="/docs/hosted-instances">Our hosted ENSNode instances</a> currently run ENSNode v1.13. If you are querying them from your own app, you <strong>must</strong> use <span set:html={sdkList} />. The latest published versions (<code>1.14.0+</code>) contain breaking changes in the Omnigraph API data model not yet deployed to our hosted infrastructure. Use these exact install commands: | ||
|
|
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
/docs/hosted-instancespage to better highlight each instances' APIs and data source (ENS deployment).Why
Testing
Notes for Reviewer (Optional)
Pre-Review Checklist (Blocking)